// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef UI_AURA_TEST_AURA_TEST_HELPER_H_
#define UI_AURA_TEST_AURA_TEST_HELPER_H_

#include "base/macros.h"
#include "base/memory/scoped_ptr.h"
#include "ui/aura/window_event_dispatcher.h"
#include "ui/aura/window_tree_host.h"

namespace base {
class MessageLoopForUI;
}

namespace ui {
class ContextFactory;
class InputMethod;
class ScopedAnimationDurationScaleMode;
}

namespace aura {
class TestScreen;
namespace client {
    class DefaultCaptureClient;
    class FocusClient;
}
namespace test {
    class TestWindowTreeClient;

    // A helper class owned by tests that does common initialization required for
    // Aura use. This class creates a root window with clients and other objects
    // that are necessary to run test on Aura.
    class AuraTestHelper {
    public:
        explicit AuraTestHelper(base::MessageLoopForUI* message_loop);
        ~AuraTestHelper();

        // Creates and initializes (shows and sizes) the RootWindow for use in tests.
        void SetUp(ui::ContextFactory* context_factory);

        // Clean up objects that are created for tests. This also deletes the Env
        // object.
        void TearDown();

        // Flushes message loop.
        void RunAllPendingInMessageLoop();

        Window* root_window() { return host_->window(); }
        ui::EventProcessor* event_processor() { return host_->event_processor(); }
        WindowTreeHost* host() { return host_.get(); }

        TestScreen* test_screen() { return test_screen_.get(); }

    private:
        base::MessageLoopForUI* message_loop_;
        bool setup_called_;
        bool teardown_called_;
        bool env_created_;
        scoped_ptr<WindowTreeHost> host_;
        scoped_ptr<TestWindowTreeClient> stacking_client_;
        scoped_ptr<client::DefaultCaptureClient> capture_client_;
        scoped_ptr<client::FocusClient> focus_client_;
        scoped_ptr<TestScreen> test_screen_;
        scoped_ptr<ui::ScopedAnimationDurationScaleMode> zero_duration_mode_;

        DISALLOW_COPY_AND_ASSIGN(AuraTestHelper);
    };

} // namespace test
} // namespace aura

#endif // UI_AURA_TEST_AURA_TEST_HELPER_H_
